Skip to content

feat: support codecv8 #1206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat: support codecv8 #1206

wants to merge 2 commits into from

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Jun 16, 2025

1. Purpose or design rationale of this PR

This PR adds support for codecv8. e.g., to ensure batch hashes or codecv8 are calculated correctly.

2. PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • feat: A new feature

3. Deployment tag versioning

Has the version in params/version.go been updated?

  • Yes

4. Breaking change label

Does this PR have the breaking-change label?

  • This PR is not a breaking change

Summary by CodeRabbit

  • Chores
    • Updated an internal dependency to the latest version.
    • Increased the patch version number to 56.
  • Bug Fixes
    • Improved batch version handling to support a broader range of codec versions.
  • Tests
    • Added new tests to validate batch processing with the latest codec version.

Copy link

coderabbitai bot commented Jun 16, 2025

Walkthrough

The changes update the version of the github.com/scroll-tech/da-codec dependency in the go.mod file and increment the patch version constant from 55 to 56 in params/version.go. Additionally, batch codec version checks in rollup_sync_service.go were broadened from an exact match with CodecV7 to a range check for versions greater or equal to CodecV7, with corresponding error message updates. A new test for batch validation using CodecV8 was added in rollup_sync_service_test.go.

Changes

File(s) Change Summary
go.mod Updated github.com/scroll-tech/da-codec dependency to a newer version.
params/version.go Incremented VersionPatch constant from 55 to 56.
rollup/rollup_sync_service/*.go Changed batch codec version checks from exact CodecV7 to >= CodecV7, updated related comments and error messages.
rollup/rollup_sync_service/*_test.go Added TestValidateBatchCodecV8 to test batch validation logic for CodecV8 batches.

Possibly related PRs

Suggested labels

bump-version

Suggested reviewers

  • jonastheis
  • Thegaram

Poem

A hop, a skip, a version bump,
Codec freshened, thump-thump-thump!
Patch now fifty-six, we cheer,
New dependencies, nothing to fear.
With every change, the code’s in sync—
Rabbits rejoice, and noses wink! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 842d654 and 27168a2.

📒 Files selected for processing (2)
  • rollup/rollup_sync_service/rollup_sync_service.go (3 hunks)
  • rollup/rollup_sync_service/rollup_sync_service_test.go (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: test
  • GitHub Check: check
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (go)
🔇 Additional comments (4)
rollup/rollup_sync_service/rollup_sync_service.go (3)

467-473: LGTM: Proper generalization for codec version support.

The update from exact CodecV7 matching to >= CodecV7 correctly extends support to CodecV8 and future codec versions while maintaining backward compatibility.


496-501: LGTM: Consistent error message improvement.

The error message now dynamically includes the actual codec version instead of hardcoding "CodecV7", which provides better debugging information and aligns with the generalized version check logic.


566-571: LGTM: Consistent logic generalization.

The comment and error message updates maintain consistency with the other changes, properly supporting CodecV8 and future versions while providing accurate error information.

rollup/rollup_sync_service/rollup_sync_service_test.go (1)

819-962: LGTM: Comprehensive test coverage for CodecV8.

The new test function properly validates CodecV8 functionality by:

  1. Creating batches with the CodecV8 codec
  2. Testing both single batch validation and multi-batch finalization scenarios
  3. Properly computing L1 message queue hashes using MessageQueueV2ApplyL1MessagesFromBlocks
  4. Validating all expected batch metadata fields (batch hash, L1 messages popped, state root, withdraw root)
  5. Following the same comprehensive pattern as the existing TestValidateBatchCodecV7 test

This ensures that the logic changes in rollup_sync_service.go work correctly with CodecV8 batches.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

georgehao
georgehao previously approved these changes Jun 18, 2025
Copy link

@jonastheis jonastheis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to be updated:

if commitedBatch.Version() == encoding.CodecV7 {

It would be good to add some test cases with CodecV8 to the rollup verifier to make sure it works as expected.

@colinlyguo
Copy link
Member Author

I think this needs to be updated:

if commitedBatch.Version() == encoding.CodecV7 {

It would be good to add some test cases with CodecV8 to the rollup verifier to make sure it works as expected.

Oh, nice catch. will add.

@colinlyguo
Copy link
Member Author

I think this needs to be updated:

if commitedBatch.Version() == encoding.CodecV7 {

It would be good to add some test cases with CodecV8 to the rollup verifier to make sure it works as expected.

Added in this commit: 27168a2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants